Data Groups
With few exceptions, data groups must be defined in a device template file (DTF) in order for them to be available for use on a remote device. Which data groups are defined by a device template file depends on protocol, device type, and unique configuration.
CygNet distributes sample device template files for its EIEs, each of which typically serves one or more hardware models along with applicable firmware. Therefore, the data groups described below are only those data groups defined by CygNet in sample device template file(s). Your template(s) might not include some of the data groups described below. Device template files exist to enable users to customize device configurations; however, CygNet is not responsible for changes made by users.
For information about data group definitions and device template files, see Device Template Files.
For more information about data group dependencies, see Data Group Dependencies.
Notes:
- Except for UDC mapping, native, predefined data groups can not be altered in the device template file. Only the "Generic TLP Data" data group enables user alterations.A valid "ROC Config" (RtuConfig) data group must be retrieved before other data groups can be retrieved or sent. The data group should always be repolled if there are configuration changes to the field device, after a CygNet upgrade, after importing a device or after modifying the device template file.
- The attribute minFirmwareVer can be configured in the device template file to specify the minimum firmware version supported for the specified TLP of the DEID. If the firmware version information has not been successfully retrieved from the field device, any TLP using the minFirmwareVer attribute will be excluded. To retrieve the firmware version information, poll the "ROC Config" (RtuConfig) data group or the "System Variables" (SysVars) data group.
-
When point processing is performed on history data groups, only closed records will be published and processed to points. If a device has leading timestamped records and returns the current, open record, point processing will not be performed for that record, even though there is data in the DDS transaction. The point record will be updated only when that record is closed. This is to avoid a situation where a point has multiple entries with the same timestamp, since an open record may be still updating values with each new poll, but each update will have the same timestamp. For example, say you start polling for a daily history record at 8:00am, you’ll get the first value at 8:00am, then if you poll every five minutes, you’ll get new values throughout the day at the exact same timestamp. A history record is basically an array of data with a timestamp and values where the values have different process variables for each incremental poll. The timestamp won’t get written until the record is closed, which happens at the end of the time period, in this case, a day.
-
Best practice recommends that you do not perform UDC and point processing on FMS data groups. The DEIDs specified in FMS data groups are generic and use the eFMS enumeration to identify the CygNet-defined FMS items referenced in the device template file. No polling is done on these data groups — all data is coming from the native data groups. Points should be mapped to the native data groups since that is the data group that is actually processing the device data. While point processing may work on the FMS data groups, it is not supported, not tested, not consistent across EIEs, and is not recommended practice.
- CygNet Gas Measurement Repository (GMR) has been discontinued. Effective with the CygNet v8.5.0 release, GMR files must be migrated to FMS. See Migrating Data Groups from GMR to FMS to migrate data groups for Emerson ROC devices.
Emerson ROC EIE Data Groups
Browse by letter: [A] [B] [C] [D] [E] [F] [G] [H] [I] [L] [M] [P] [R] [S] [T] [U] [V] [X]
| Data Group Type | Usage Notes |
|---|---|
|
The "AGA Flow Calc Values" data group uses point type 10. |
|
|
AGAParams |
The "AGA Gas/Flow Parms" data group uses point type 7. |
|
AI |
The "Analog Input" data group uses point type 3. |
|
"Alarms Log" |
|
|
The "Analog Output" data group uses point type 4. |
|
|
"Daily Archive Data" |
|
|
AuditClear |
"Audit Log Clearing" only applies to Industry Canada (IC) devices. The "Audit Log Clearing" data group enables viewing of "Audit Log" transactions for every manual clear executed using the "Audit Log" data group. Use the Transaction drop-down menu to view failed and successful gets. Each get represents an attempt to clear event records in the "Audit Log" data group. |
|
"Audit Log" only applies to Industry Canada (IC) devices. The "Audit Log" data group enables the auditing of a select group of events. Note: In the following entry, the word clear has two, potentially confusing meanings. Records marked cleared/uncleared are records that have been recorded as read and saved by the host. However, clearing an audit log means deleting all event records from the audit log. The following notes apply to only 300/IC and 400/IC devices: In the Date Parameters dialog box that appears when you click Get from RTU, the following options appear:
Under Options, click Clear Log to delete all event records from the audit log. The following notes apply to only FloBoss 107/IC devices: Event records retrieved from 107/IC field devices are always returned marked as cleared, so Get all uncleared records is unavailable with 107/IC devices. Under Options, click Clear Log to delete all event records from the audit log. |
|
|
"Basic Poll" |
|
|
"CMD – Write Config Memory" is a special case of "Generic TLP Data" for writing to config memory. |
|
|
ConOpCfg |
"Configurable Opcode Settings" If you add this data group, also add a "Configurable Opcode Data" data group. Use ROCLINK to configure a configurable Opcode table. Although ROCLink allows you to skip items when configuring the table, CygNet requires the items to be contiguous. If you make changes to the Opcode table configuration, poll this data group afterward. |
|
The "Configurable Opcode Data" data group works in conjunction with a "Configurable Opcode Settings" data group. Retrieving this data group automatically retrieves required configurable Opcode settings. If you add this data group, also add a "Configurable Opcode Settings" data group. Use ROCLINK to configure a configurable Opcode table. Although ROCLink allows you to skip items when configuring the table, CygNet requires the items to be contiguous. If you make changes to the Opcode table configuration, poll this data group afterwards. If you request a "Configurable Opcode Data" data group for an Emerson ROC remote device, you receive an invalid header error if the table contains one or more user-defined points (UDPs) for which the data type is not a floating-point number (FLP). The EIE does not know the data type for user-defined points because they are user-defined. |
|
|
"Time / Date" |
|
|
DensityIF |
The "Density Interface Parameters" data group uses point type 26. See also Collecting Liquid Periodic Data. |
|
DI |
The "Discrete Input" data group uses point type 1. |
|
Diag |
"Diagnostics Summary" |
|
Diag00 |
"Diagnostics: CPU Module" |
|
Diag01Dvs |
"Diagnostics: Integral Sensor DVS" |
|
Diag01Pim |
"Diagnostics: Integral Sensor PIM" |
|
Diag02 |
"Diagnostics: LCD Controller" |
|
Diag03 |
"Diagnostics: LCD Module" |
|
Diag04Io |
"Diagnostics: Slot 0 Onboard I/O" |
|
Diag04NoIo |
"Diagnostics: Slot 0 No I/O" |
|
Diag05Aux |
"Diagnostics: Slot 1 Aux I/O" |
|
Diag05Mvs |
"Diagnostics: Slot 1 MVS I/F" |
|
Diag06Aux |
"Diagnostics: Slot 2 Aux I/O" |
|
Diag06Mvs |
"Diagnostics: Slot 2 MVS I/F' |
|
Diag07Aux |
"Diagnostics: Slot 3 Aux I/O" |
|
Diag07Mvs |
"Diagnostics: Slot 3 MVS I/F" |
|
Diag08Aux |
"Diagnostics: Slot 4 Aux I/O" |
|
Diag08Mvs |
"Diagnostics: Slot 4 MVS I/F" |
|
Diag09Aux |
"Diagnostics: Slot 5 Aux I/O" |
|
Diag09Mvs |
"Diagnostics: Slot 5 MVS I/F" |
|
Diag10Aux |
"Diagnostics: Slot 6 Aux I/O" |
|
Diag10Mvs |
"Diagnostics: Slot 6 MVS I/F" |
|
Diag11Aux |
"Diagnostics: Slot 7 Aux I/O" |
|
Diag11Mvs |
"Diagnostics: Slot 7 MVS I/F" |
|
The "Discrete Output" data group uses point type 2. |
|
|
"Events Log " |
|
|
"Extended History" |
|
|
ExtHstParm |
"Extended History Parameters" Note: Only one instance of this data group is allowed. |
|
"FMS Alarms" FMS data group units displayed in the DDS reflect their points of origin. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. Dependencies:
|
|
|
FmsConfig |
"FMS Configuration" is required if you use FMS. When adding an "FMS Configuration" data group, specify the meter type and ordinal number of the supporting meter configuration data group in the Meter Type area. The Ordinal values supplied reflect FloBoss 107 meter support, which provides a maximum of 4 gas meters + a maximum of 2 liquid meters. The 2 liquid meters become available only after loading the Liquid Allocation user program to the applicable FloBoss 107 field device. When you select a gas meter type, you can choose from 4 ordinals or meters. When you select a liquid meter type, you can choose from 2 ordinals or meters. Possible meter type options are as follows:
This data group supports send/write functionality. However, sends can only be initiated from FMS. Sending periodic quality from FMS to a field device requires you to instantiate each "FMS Configuration" support data group for the applicable remote device before initiating the send from FMS. For information about how this data group maps to FMS config items in a FloBoss 107 device, see FMS Config Data Group Mapping. FMS data group units displayed in the DDS reflect their points of origin. "FMS Configuration" must be retrieved before polling other FMS data groups of the same ordinal. Dependencies:
|
|
"FMS Events" Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. FMS data group units displayed in the DDS reflect their points of origin. A "Special Configuration Events" event appears in the Event Category column of the "FMS Events" data if any one of the following configuration properties is changed on a field device:
The "special" status sets a flag for the event's display in FMS Explorer. See Special Configuration Events for more information about these events. Dependencies:
|
|
|
"FMS Daily PM History" History points must be defined in this data group's properties. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. FMS data group units displayed in the DDS reflect their points of origin. For information about how ordinals are formed for this data group, see History Ordinals and Points. Dependencies:
Note: The Emerson FloBoss 107 and FBx devices use Opcode 136 (History Multiple Points Periodic) for polling FMS Daily History. Opcode 136 is only available on the FloBoss 107 and FBx devices. |
|
|
"FMS Daily PQ History" History points must be defined in this data group's properties. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. FMS data group units displayed in the DDS reflect their points of origin. For information about how ordinals are formed for this data group, see History Ordinals and Points. Dependencies:
Note: The Emerson FloBoss 107 and FBx devices use Opcode 136 (History Multiple Points Periodic) for polling FMS Daily History. Opcode 136 is only available on the FloBoss 107 and FBx devices. |
|
|
"FMS Hourly PM History" History points must be defined in this data group's properties. You can use the "History Point List" data group to locate history point values. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. FMS data group units displayed in the DDS reflect their points of origin. For information about how ordinals are formed for this data group, see History Ordinals and Points. Dependencies:
Note: The Emerson FloBoss 107 and FBx devices use Opcode 136 (History Multiple Points Periodic) for polling FMS Daily History. Opcode 136 is only available on the FloBoss 107 and FBx devices. |
|
|
"FMS Hourly PQ History" History points must be defined in this data group's properties. You can use the "History Point List" data group to locate history point values. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. FMS data group units displayed in the DDS reflect their points of origin. For information about how ordinals are formed for this data group, see History Ordinals and Points. Dependencies:
Note: The Emerson FloBoss 107 and FBx devices use Opcode 136 (History Multiple Points Periodic) for polling FMS Daily History. Opcode 136 is only available on the FloBoss 107 and FBx devices. |
|
|
FmsProduct |
"FMS Liquid Product" enables the retrieval of liquid product data by an associated CygNet Measurement system. A single set of two liquid products is shared by all liquid meters. However, liquid product data is sent to FMS with meter-specific data on a per-meter basis. Each instance of LiqMeter and its corresponding FmsProduct data group share both the set of liquid products as well as meter-specific product values. Applicable RtuConfig, FmsConfig, LiqMeter, and FmsProduct data group types must be instantiated to poll FmsProduct. RtuConfig and FmsConfig must be polled before polling FmsProduct. Dependencies:
|
|
FmsRocPac |
"ROCPAC Support for Fms" |
|
FSTParameters |
The "FST Parameters" data group uses point type 16. |
|
FSTReg |
"FST Registers " |
|
"Generic TLP Data" |
|
|
GmrRocPac |
"ROCPAC for FMS Legacy" |
|
The "Sixty Minute Point History" data group is used to optimize the retrieval of row-based minute history for multiple points using Opcode 126. See also History Retrieval Optimization. |
|
|
The "History Multiple Points Daily" data group is used to optimize the retrieval of row-based daily history for multiple points using Opcode 136 (History Multiple Points Periodic). See also History Retrieval Optimization. |
|
|
The "History Multiple Points Extended" data group is used to optimize the retrieval of row-based extended history for multiple points using Opcode 136 (History Multiple Points Periodic). See also History Retrieval Optimization. |
|
|
The "History Multiple Points Periodic" data group is used to optimize the retrieval of row-based periodic history for multiple points using Opcode 136 (History Multiple Points Periodic). See also History Retrieval Optimization. |
|
|
HistPtCfg |
"History Point List" |
|
"I/O Point List" enables you to request the type and/or logical number of all I/O points in their physical order from a connected field device. This in turn enables you to focus on only those I/O point collections you most care about, making it easier to create your own I/O data groups. IoPntCfg uses Opcode 50. You can select the Add Data Groups button to automatically create I/O data groups that have not previously been created. The Tag column does not display a value until that I/O data group has been retrieved. |
|
|
The "Liquid Meter Parameters" data group uses point type 25. See also Collecting Liquid Periodic Data. |
|
|
LiqPref |
The "Liquid Preferences Parameters" data group uses point type 22. See also Collecting Liquid Periodic Data. |
|
LiqProd |
The "Liquid Product Parameters" data group uses point type 23. See also Collecting Liquid Periodic Data. |
|
The "Login Request" data group is only relevant if the port being used to communicate with the target field device is security enabled. This data group enables a user with valid credentials to communicate with a field device from the CygNet host. As long as that user is logged in, subsequent messaging is allowed through the relevant communication port and the user's ID is included in event log records. If the relevant port is security enabled, a log-in request using invalid data will fail with an error message of "device rejected request, code 21". Subsequent invalid requests will fail with "device rejected request, code 20", which is a security failure. The "Login Credentials" data group can be used to see the valid credentials as they are defined on a field device. If the relevant port is security disabled, a log-in request with invalid data will succeed since no internal Emerson validation is performed. A user might be unexpectedly logged out if any one of the following conditions occurs:
See Emerson device security documentation for more details. |
|
|
The "Login Credentials" data group uses point type 57. This data group reads operator IDs and their corresponding password and access level from a field device. These items must be configured on the field device before CygNet can read them. The field device does not allow the credentials to be configured from external applications like CygNet. The credentials that are displayed in this data group are the only valid ones that can be used in the "Login Request" data group. As with all CygNet data groups, you can set individual CygNet security permissions for this data group. |
|
|
The "Login Secure Enhanced Request" data group enables a user with enhanced security credentials to communicate with a field device from the CygNet host. The login request is issued to the device via Opcode 17. The data group operates with a Login Secure UIS command and LOGINSEC command component type. Enhanced secure login credentials are configured in the Login secure section of the Device page of the remote device editor. Note: This data group applies to FloBoss 107 remote devices only. It complies with enhanced security features required by the United States Transport Security Administration (TSA) Security Directive Pipeline-2021-02. See Emerson device security documentation for more information. |
|
|
"Meter Config Parameters" |
|
|
MetCfg |
"Meter Config Params (Basic)" |
|
MetCfg107 |
"Meter Config Params (Extra 107)" |
|
MetFlow |
"Meter Flow Values" |
|
MetFlow |
"Meter Flow Values (Basic)" |
|
MetFlowE |
"Meter Flow Values (Extra 107)" |
|
MVS |
"Multi-Variable Sensor" |
|
"Periodic History" See History Retrieval Optimization. For information about how ordinals are formed for this data group, see History Ordinals and Points. |
|
|
PIDControl |
"PID" |
|
PIDParms |
"PID Control Params" |
|
PIDParmsE |
"PID Control Params (Extended)" |
|
PulseInput |
"Pulse Input" |
|
A valid "ROC Config" data group must be retrieved before other data groups can be retrieved or sent. The data group should always be repolled if there are configuration changes to the field device, after a CygNet upgrade, after importing a device or after modifying the device template file. |
|
|
RunParm |
"Run Parameters" |
|
"Single TLP" enables you to read from and write to a single user-specified TLP. You can use a single-element data group on an ad hoc basis from a data group editor or set up a UIS command that uses a single-element data group. You can use a remote device editor dialog box to enter a user-defined TLP. To do so, configure the data group as usual, but type in the desired values for the fields Point type, Logical #, and Parameter # in the TLP settings. Both the Point type and Parameter # fields are combo boxes that enable you to type your own values rather than only selecting from a list of known TLPs. |
|
|
SoftPntExt |
"Soft Points Extended" applies to FloBoss 107 and 107IC remote devices. Uses point type 98 to retrieve an extended definition of soft points. |
|
"Soft Points" A type of point with generic parameters that you can configure to hold data as desired. |
|
|
SysFlgs |
"System Flags" |
|
"System Variables" |
|
|
"Tank Parameters" |
|
|
The "User Program Status" data group uses point type 94. It enables the retrieval of status information for a user-defined C program used on a specific Emerson field device. If the user program version information has not been successfully retrieved from the field device, any TLP using the minUProgVer attribute will be excluded. To retrieve the user program version information, poll the "ROC Config" (RtuConfig) data group or the "User Program Status" (UserPgStat) data group. See also User Programs. |
|
|
UserProg |
The "User Program Configuration" data group uses point type 94. It enables the retrieval of configuration information for a user-defined C program used on a specific Emerson field device. See also User Programs. |
|
"V-Cone 5 Meter Run Configuration" The corresponding V-Cone user program is called V-Cone_5.bin. It is loaded into user program location 5 and uses point type 31. This data group is only meaningful if you've installed the relevant cone user program on your field device. If you are uncertain, poll "User Program Status" and confirm. |
|
|
VCone6 |
"V-Cone 6 Meter Run Configuration" The corresponding V-Cone user program is called V-Cone_6.bin. It is loaded into user program location 6 and uses point type 33. This data group is only meaningful if you've installed the relevant cone user program on your field device. If you are uncertain, poll "User Program Status" and confirm. |
|
The "Extra Run Parameters" data group uses point type 42. |


